<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>SemOpt: OrClause Class Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>


</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">SemOpt
   &#160;<span id="projectnumber">0.2alpha5-SCC</span>
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.6.1 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('classOrClause.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">OrClause Class Reference</div>  </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="OrClause" -->
<p>Class encompassing a list of SAT variables (type `Variable`) linked by or operators.  
 <a href="classOrClause.html#details">More...</a></p>

<p><a href="classOrClause-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOrClause.html#a4631acd310d445535a08e84d51c84f6e">OrClause</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Simple constructor.  <a href="#a4631acd310d445535a08e84d51c84f6e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOrClause.html#ae85000bdcd5e0c96cb5369cf4d59240e">OrClause</a> (int,...)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor that can receive as input a list of variables.  <a href="#ae85000bdcd5e0c96cb5369cf4d59240e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOrClause.html#a09a95fb8ce2a1d10ae7c22295265725c">appendVariable</a> (<a class="el" href="classVariable.html">Variable</a>)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Method for adding a variable at the end of the clause.  <a href="#a09a95fb8ce2a1d10ae7c22295265725c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOrClause.html#a3ad02fa758db9d8b4a432e4c5ee7638e">addHeadVariable</a> (<a class="el" href="classVariable.html">Variable</a>)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Method for adding a variable at the beginning of the clause.  <a href="#a3ad02fa758db9d8b4a432e4c5ee7638e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOrClause.html#a4602e98acda51523bf55cc2ca1d59ad6">toSS</a> (stringstream *) const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Method for returning a string representation of the Or clause in a `stringstream` object.  <a href="#a4602e98acda51523bf55cc2ca1d59ad6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOrClause.html#ae8edb2f491a3b4f5d8bd402ef1788d82">clone</a> (<a class="el" href="classOrClause.html">OrClause</a> *)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Method for cloning this <a class="el" href="classOrClause.html" title="Class encompassing a list of SAT variables (type `Variable`) linked by or operators.">OrClause</a> into a new <a class="el" href="classOrClause.html" title="Class encompassing a list of SAT variables (type `Variable`) linked by or operators.">OrClause</a> that is passed as input output parameter.  <a href="#ae8edb2f491a3b4f5d8bd402ef1788d82"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Class encompassing a list of SAT variables (type `Variable`) linked by or operators. </p>
<p>For example, the or clause "var1 OR var2 OR var3 OR not var 4 OR var 5" can be defined as OrClause(5, var1, var2, var3, not var4, var5) </p>
<dl class="author"><dt><b>Author:</b></dt><dd>Federico Cerutti &lt;<a href="mailto:f.cerutti@abdn.ac.uk">f.cerutti@abdn.ac.uk</a>&gt; </dd></dl>
<dl class="copyright"><dt><b>Copyright:</b></dt><dd>GNU Public License v2 </dd></dl>

<p>Definition at line <a class="el" href="OrClause_8h_source.html#l00011">11</a> of file <a class="el" href="OrClause_8h_source.html">OrClause.h</a>.</p>
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a4631acd310d445535a08e84d51c84f6e"></a><!-- doxytag: member="OrClause::OrClause" ref="a4631acd310d445535a08e84d51c84f6e" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classOrClause.html#a4631acd310d445535a08e84d51c84f6e">OrClause::OrClause</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Simple constructor. </p>
<p>No parameters required, it initializes the data structure but it adds no variables to the clause </p>

<p>Definition at line <a class="el" href="OrClause_8cpp_source.html#l00018">18</a> of file <a class="el" href="OrClause_8cpp_source.html">OrClause.cpp</a>.</p>

<p>Referenced by <a class="el" href="OrClause_8cpp_source.html#l00087">clone()</a>.</p>

</div>
</div>
<a class="anchor" id="ae85000bdcd5e0c96cb5369cf4d59240e"></a><!-- doxytag: member="OrClause::OrClause" ref="ae85000bdcd5e0c96cb5369cf4d59240e" args="(int,...)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classOrClause.html#a4631acd310d445535a08e84d51c84f6e">OrClause::OrClause</a> </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>count</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>...</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Constructor that can receive as input a list of variables. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">count</td><td>The number of variables that follows </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">....</td><td>The list of variables that follows, instances of type `Variable`</td></tr>
  </table>
  </dd>
</dl>
<p>For instance, OrClause(3, var1, var2, var3) </p>

<p>Definition at line <a class="el" href="OrClause_8cpp_source.html#l00029">29</a> of file <a class="el" href="OrClause_8cpp_source.html">OrClause.cpp</a>.</p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a3ad02fa758db9d8b4a432e4c5ee7638e"></a><!-- doxytag: member="OrClause::addHeadVariable" ref="a3ad02fa758db9d8b4a432e4c5ee7638e" args="(Variable)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classOrClause.html#a3ad02fa758db9d8b4a432e4c5ee7638e">OrClause::addHeadVariable</a> </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classVariable.html">Variable</a>&#160;</td>
          <td class="paramname"><em>x</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Method for adding a variable at the beginning of the clause. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">x</td><td>The variable to add (of type `Variable`) </td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt><b>Return values:</b></dt><dd>
  <table class="retval">
    <tr><td class="paramname">void</td><td></td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="OrClause_8cpp_source.html#l00056">56</a> of file <a class="el" href="OrClause_8cpp_source.html">OrClause.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a09a95fb8ce2a1d10ae7c22295265725c"></a><!-- doxytag: member="OrClause::appendVariable" ref="a09a95fb8ce2a1d10ae7c22295265725c" args="(Variable)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classOrClause.html#a09a95fb8ce2a1d10ae7c22295265725c">OrClause::appendVariable</a> </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classVariable.html">Variable</a>&#160;</td>
          <td class="paramname"><em>x</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Method for adding a variable at the end of the clause. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">x</td><td>The variable to add </td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt><b>Return values:</b></dt><dd>
  <table class="retval">
    <tr><td class="paramname">void</td><td></td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="OrClause_8cpp_source.html#l00046">46</a> of file <a class="el" href="OrClause_8cpp_source.html">OrClause.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="ae8edb2f491a3b4f5d8bd402ef1788d82"></a><!-- doxytag: member="OrClause::clone" ref="ae8edb2f491a3b4f5d8bd402ef1788d82" args="(OrClause *)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classOrClause.html#ae8edb2f491a3b4f5d8bd402ef1788d82">OrClause::clone</a> </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classOrClause.html">OrClause</a> *&#160;</td>
          <td class="paramname"><em>newclause</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Method for cloning this <a class="el" href="classOrClause.html" title="Class encompassing a list of SAT variables (type `Variable`) linked by or operators.">OrClause</a> into a new <a class="el" href="classOrClause.html" title="Class encompassing a list of SAT variables (type `Variable`) linked by or operators.">OrClause</a> that is passed as input output parameter. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in,out]</td><td class="paramname">newclause</td><td>Pointer to another `OrClause` object, which is newly initialised, and then which will become a clone (*not a pointer*) of this object </td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt><b>Return values:</b></dt><dd>
  <table class="retval">
    <tr><td class="paramname">void</td><td></td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="OrClause_8cpp_source.html#l00087">87</a> of file <a class="el" href="OrClause_8cpp_source.html">OrClause.cpp</a>.</p>

<p>References <a class="el" href="OrClause_8cpp_source.html#l00018">OrClause()</a>.</p>

</div>
</div>
<a class="anchor" id="a4602e98acda51523bf55cc2ca1d59ad6"></a><!-- doxytag: member="OrClause::toSS" ref="a4602e98acda51523bf55cc2ca1d59ad6" args="(stringstream *) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classOrClause.html#a4602e98acda51523bf55cc2ca1d59ad6">OrClause::toSS</a> </td>
          <td>(</td>
          <td class="paramtype">stringstream *&#160;</td>
          <td class="paramname"><em>ss</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Method for returning a string representation of the Or clause in a `stringstream` object. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in,out]</td><td class="paramname">ss</td><td>A pointer to an already initialised `stringstream` object which will contain the string representation of this object </td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt><b>Return values:</b></dt><dd>
  <table class="retval">
    <tr><td class="paramname">void</td><td></td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="OrClause_8cpp_source.html#l00068">68</a> of file <a class="el" href="OrClause_8cpp_source.html">OrClause.cpp</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/<a class="el" href="OrClause_8h_source.html">OrClause.h</a></li>
<li>src/<a class="el" href="OrClause_8cpp_source.html">OrClause.cpp</a></li>
</ul>
</div><!-- contents -->
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="classOrClause.html">OrClause</a>      </li>

    <li class="footer">Generated on Fri Jan 17 2014 11:47:52 for SemOpt by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.6.1 </li>
   </ul>
 </div>


</body>
</html>
